home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.3 / GetColor.3 < prev    next >
Text File  |  1995-07-21  |  10KB  |  326 lines
  1. '\"
  2. '\" Copyright (c) 1990, 1991 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/GetColor.3,v 1.9 93/04/01 09:41:25 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tk_GetColor tkc
  206. .BS
  207. .SH NAME
  208. Tk_GetColor, Tk_GetColorByValue, Tk_NameOfColor Tk_FreeColor \- maintain database of colors
  209. .SH SYNOPSIS
  210. .nf
  211. \fB#include <tk.h>\fR
  212. .sp
  213. XColor *
  214. \fBTk_GetColor\fR(\fIinterp, tkwin, colorMap, nameId\fB)\fR
  215. .sp
  216. XColor *
  217. \fBTk_GetColorByValue\fR(\fIinterp, tkwin, colorMap, prefPtr\fB)\fR
  218. .sp
  219. char *
  220. \fBTk_NameOfColor(\fIcolorPtr\fB)\fR
  221. .sp
  222. \fBTk_FreeColor(\fIcolorPtr\fB)\fR
  223. .SH ARGUMENTS
  224. .AS "Tcl_Interp" *colorPtr
  225. .AP Tcl_Interp *interp in
  226. Interpreter to use for error reporting.
  227. .AP Tk_Window tkwin in
  228. Token for window in which color will be used.
  229. .AP Colormap colormap in
  230. Colormap from which to allocate color.  If None, then the default
  231. colormap for \fItkwin\fR's screen is used.
  232. .AP Tk_Uid nameId in
  233. Textual description of desired color.
  234. .AP XColor *prefPtr in
  235. Indicates red, green, and blue intensities of desired
  236. color.
  237. .AP XColor *colorPtr in
  238. Pointer to X color information.  Must have been allocated by previous
  239. call to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR, except when passed
  240. to \fBTk_NameOfColor\fR.
  241. .BE
  242.  
  243. .SH DESCRIPTION
  244. .PP
  245. The \fBTk_GetColor\fR and \fBTk_GetColorByValue\fR procedures
  246. locate pixel values that may be used to render particular
  247. colors in the window given by \fItkwin\fR using the colormap
  248. given by \fIcolormap\fR.  In \fBTk_GetColor\fR
  249. the desired color is specified with a Tk_Uid (\fInameId\fR), which
  250. may have any of the following forms:
  251. .TP 20
  252. \fIcolorname\fR
  253. Any of the valid textual names for a color defined in the
  254. server's color database file, such as \fBred\fR or \fBPeachPuff\fR.
  255. .TP 20
  256. \fB#\fIRGB\fR
  257. .TP 20
  258. \fB#\fIRRGGBB\fR
  259. .TP 20
  260. \fB#\fIRRRGGGBBB\fR
  261. .TP 20
  262. \fB#\fIRRRRGGGGBBBB\fR
  263. A numeric specification of the red, green, and blue intensities
  264. to use to display the color.  Each \fIR\fR, \fIG\fR, or \fIB\fR
  265. represents a single hexadecimal digit.  The four forms permit
  266. colors to be specified with 4-bit, 8-bit, 12-bit or 16-bit values.
  267. When fewer than 16 bits are provided for each color, they represent
  268. the most significant bits of the color.  For example, #3a7 is the
  269. same as #3000a0007000.
  270. .LP
  271. In \fBTk_GetColorByValue\fR, the desired color is indicated with
  272. the \fIred\fR, \fIgreen\fR, and \fIblue\fR fields of the structure
  273. pointed to by \fIcolorPtr\fR.
  274. .PP
  275. If \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR is successful
  276. in allocating the desired color, then it returns a pointer to
  277. an XColor structure;  the structure indicates the exact intensities of
  278. the allocated color (which may differ slightly from those requested,
  279. depending on the limitations of the screen) and a pixel value
  280. from \fIcolormap\fR that may be used to draw in the color.
  281. If an error occurs in allocating a color then NULL is returned
  282. and an error message will be stored in \fIinterp->result\fR.
  283. .PP
  284. \fBTk_GetColor\fR and \fBTk_GetColorByValue\fR maintain a database
  285. of all the colors currently in use.
  286. If the same \fInameId\fR is requested multiple times from
  287. \fBTk_GetColor\fR (e.g. by different windows), or if the
  288. same intensities are requested multiple times from
  289. \fBTk_GetColorByValue\fR, then existing pixel values will
  290. be re-used.  Re-using an existing pixel avoids any interaction
  291. with the X server, which makes the allocation much more
  292. efficient.  For this reason, you should generally use
  293. \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR
  294. instead of Xlib procedures like \fBXAllocColor\fR,
  295. \fBXAllocNamedColor\fR, or \fBXParseColor\fR.
  296. .PP
  297. Since different calls to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR
  298. may return the same shared
  299. pixel value, callers should never change the color of a pixel
  300. returned by the procedures.
  301. If you need to change a color value dynamically, you should use
  302. \fBXAllocColorCells\fR to allocate the pixel value for the color.
  303. .PP
  304. The procedure \fBTk_NameOfColor\fR is roughly the inverse of
  305. \fBTk_GetColor\fR.  If its \fIcolorPtr\fR argument was created
  306. by \fBTk_GetColor\fR, then the return value is the \fInameId\fR
  307. string that was passed to \fBTk_GetColor\fR to create the
  308. color.  If \fIcolorPtr\fR was created by a call to \fBTk_GetColorByValue\fR,
  309. or by any other mechanism, then the return value is a string
  310. that could be passed to \fBTk_GetColor\fR to return the same
  311. color.  Note:  the string returned by \fBTk_NameOfColor\fR is
  312. only guaranteed to persist until the next call to \fBTk_NameOfColor\fR.
  313. .PP
  314. When a pixel value returned by \fBTk_GetColor\fR or
  315. \fBTk_GetColorByValue\fR is no longer
  316. needed, \fBTk_FreeColor\fR should be called to release the color.
  317. There should be exactly one call to \fBTk_FreeColor\fR for
  318. each call to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR.
  319. When a pixel value is no longer in
  320. use anywhere (i.e. it has been freed as many times as it has been gotten)
  321. \fBTk_FreeColor\fR will release it to the X server and delete it from
  322. the database.
  323.  
  324. .SH KEYWORDS
  325. color, intensity, pixel value
  326.